<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>PIWavelet: projects.piwavelet.piwavelet.piwavelet.wcoherence Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">PIWavelet
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceprojects.html">projects</a></li><li class="navelem"><a class="el" href="namespaceprojects_1_1piwavelet.html">piwavelet</a></li><li class="navelem"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet.html">piwavelet</a></li><li class="navelem"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html">piwavelet</a></li><li class="navelem"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html">wcoherence</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">projects.piwavelet.piwavelet.piwavelet.wcoherence Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This class is an Python interface for the Wavelet Coherence matlab functions of the package for wavelet, cross-wavelet and coherence-wavelet analises profided by Aslak Grinsted, John C.  
 <a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a80ad1589ead857a4b8e258c975142977"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#a80ad1589ead857a4b8e258c975142977">__init__</a></td></tr>
<tr class="memitem:a5d7f2882ef814b2d31731b0a757d4688"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#a5d7f2882ef814b2d31731b0a757d4688">__call__</a></td></tr>
<tr class="memitem:a4f8485168fe986bcb963bf19b2689840"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#a4f8485168fe986bcb963bf19b2689840">plot</a></td></tr>
<tr class="memdesc:a4f8485168fe986bcb963bf19b2689840"><td class="mdescLeft">&#160;</td><td class="mdescRight">Plots the wavelet coherence.  <a href="#a4f8485168fe986bcb963bf19b2689840"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a25dfbcf50c95984383d2bac6f111ebbd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#a25dfbcf50c95984383d2bac6f111ebbd">wtcPath</a></td></tr>
<tr class="memitem:a0f1a26d08a24a960d5aadda2a7132435"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#a0f1a26d08a24a960d5aadda2a7132435">signal1</a></td></tr>
<tr class="memitem:af647f5f8dff85e72debd8f0be20708a8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#af647f5f8dff85e72debd8f0be20708a8">signal2</a></td></tr>
<tr class="memitem:a87dafc50e3d111da1df10d1a8a72586d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#a87dafc50e3d111da1df10d1a8a72586d">wtcsig</a></td></tr>
<tr class="memitem:a04c6e1e9931771326ad92523d1f2b03a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#a04c6e1e9931771326ad92523d1f2b03a">freqs</a></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class is an Python interface for the Wavelet Coherence matlab functions of the package for wavelet, cross-wavelet and coherence-wavelet analises profided by Aslak Grinsted, John C. </p>
<p>Moore and Svetlana Jevrejeva. </p>
<pre class="fragment">http://noc.ac.uk/using-science/crosswavelet-wavelet-coherence

However, the Continuous wavelet transform of the signal, in this class, is a pure python
function.</pre> </div><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a80ad1589ead857a4b8e258c975142977"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def projects.piwavelet.piwavelet.piwavelet.wcoherence.__init__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>signal1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>signal2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a5d7f2882ef814b2d31731b0a757d4688"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def projects.piwavelet.piwavelet.piwavelet.wcoherence.__call__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a4f8485168fe986bcb963bf19b2689840"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def projects.piwavelet.piwavelet.piwavelet.wcoherence.plot </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>t</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>title</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>units</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>levels</em> = <code>None</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>labels</em> = <code>None</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>pArrow</em> = <code>None</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>pSigma</em> = <code>True</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>gray</em> = <code>None</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>nameSave</em> = <code>None</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>scale</em> = <code>'log2'</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Plots the wavelet coherence. </p>
<p>PARAMETERS title: Title of the Plot units: (string) Units of the period and time (e.g. 'days') t : array with time gray: Optional - (boolean) True for gray map . </p>

</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a04c6e1e9931771326ad92523d1f2b03a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">projects.piwavelet.piwavelet.piwavelet.wcoherence.freqs</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a0f1a26d08a24a960d5aadda2a7132435"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">projects.piwavelet.piwavelet.piwavelet.wcoherence.signal1</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="af647f5f8dff85e72debd8f0be20708a8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">projects.piwavelet.piwavelet.piwavelet.wcoherence.signal2</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a25dfbcf50c95984383d2bac6f111ebbd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">projects.piwavelet.piwavelet.piwavelet.wcoherence.wtcPath</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a87dafc50e3d111da1df10d1a8a72586d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">projects.piwavelet.piwavelet.piwavelet.wcoherence.wtcsig</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>piwavelet/<a class="el" href="piwavelet_8py.html">piwavelet.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 21 2013 12:58:16 for PIWavelet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
